com.inscoper.api.DiagResults¶

DiagResults class contains the results from a device diagnostic. More...

Public Functions¶

	Name
synchronized void	delete()
	DiagResults() Default constructor.
void	setSubDeviceStatus(UShortESubDeviceStatusMap statusMap) Set sub-device statuses.
ESubDeviceStatus	getSubDeviceStatus(int subDeviceTag) Get sub-device status.
EFunctionStatus	getFunctionStatus(int subDeviceTag, EFunctionType functionType) Get function status.
Constraint	getParamConstraint(int paramTag) Get parameter constraint.
UShortESubDeviceStatusMap	getSubDeviceStatusMap() Get all sub-device statuses.
void	addParamConstraint(int paramTag, Constraint constraint) Add parameter constraint.
void	addFunctionStatus(int subDeviceTag, EFunctionType functionType, EFunctionStatus functionStatus) Add function status.
String	getName() Get name.
void	setName(String name) Set name.
DriverConfig	getDriverConfig() Get driver configuration.
void	setDriverConfig(DriverConfig driverConfig) Set driver configuration.

Protected Functions¶

	Name
	DiagResults(long cPtr, boolean cMemoryOwn)
void	swigSetCMemOwn(boolean own)
void	finalize()
long	getCPtr(DiagResults obj)

Detailed Description¶

public class com.inscoper.api.DiagResults;

DiagResults class contains the results from a device diagnostic.

Aggregates status information and constraints for sub-devices of a device and their functions, providing a comprehensive report of the system's state.

Public Functions Documentation¶

function delete¶

public synchronized void delete()

function DiagResults¶

public DiagResults()

Default constructor.

Initializes a new instance of the DiagResults class.

function setSubDeviceStatus¶

public void setSubDeviceStatus(
    UShortESubDeviceStatusMap statusMap
)

Set sub-device statuses.

Parameters:

statusMap : A map associating sub-device tags with their status

Populates the map of sub-device statuses.

function getSubDeviceStatus¶

public ESubDeviceStatus getSubDeviceStatus(
    int subDeviceTag
)

Get sub-device status.

Parameters:

subDeviceTag : The tag of the sub-device

Return: The status of the sub-device

Retrieves the status of a specific sub-device.

function getFunctionStatus¶

public EFunctionStatus getFunctionStatus(
    int subDeviceTag,
    EFunctionType functionType
)

Get function status.

Parameters:

subDeviceTag : The tag of the sub-device
functionType : The type of function to query

Return: The status of the function

Retrieves the status of a specific function on a sub-device.

function getParamConstraint¶

public Constraint getParamConstraint(
    int paramTag
)

Get parameter constraint.

Parameters:

paramTag : The tag of the parameter

Return: A shared pointer to the constraint object

Retrieves the constraint object associated with a specific parameter.

function getSubDeviceStatusMap¶

public UShortESubDeviceStatusMap getSubDeviceStatusMap()

Get all sub-device statuses.

Return: A map of sub-device tags to statuses

Retrieves the complete map of sub-device statuses.

function addParamConstraint¶

public void addParamConstraint(
    int paramTag,
    Constraint constraint
)

Add parameter constraint.

Parameters:

paramTag : The tag of the parameter
constraint : The constraint object to add

Adds or updates a constraint for a specific parameter.

function addFunctionStatus¶

public void addFunctionStatus(
    int subDeviceTag,
    EFunctionType functionType,
    EFunctionStatus functionStatus
)

Add function status.

Parameters:

subDeviceTag : The tag of the sub-device
functionType : The type of function
functionStatus : The status to add

Adds the status of a specific function on a sub-device.

function getName¶

public String getName()

Get name.

Return: The name

Retrieves the name associated with this diagnostic result.

function setName¶

public void setName(
    String name
)

Set name.

Parameters:

name : The name

Sets the name associated with this diagnostic result.

function getDriverConfig¶

public DriverConfig getDriverConfig()

Get driver configuration.

Return: A shared pointer to the DriverConfig

Retrieves the driver configuration associated with the diagnostic.

function setDriverConfig¶

public void setDriverConfig(
    DriverConfig driverConfig
)

Set driver configuration.

Parameters:

driverConfig : The new DriverConfig pointer

Sets the driver configuration associated with the diagnosis.

Protected Functions Documentation¶

function DiagResults¶

protected DiagResults(
    long cPtr,
    boolean cMemoryOwn
)

function swigSetCMemOwn¶

protected void swigSetCMemOwn(
    boolean own
)

function finalize¶

protected void finalize()

function getCPtr¶

protected static long getCPtr(
    DiagResults obj
)

Updated on 2026-04-02 at 10:55:37 +0200